<!doctype html>
<html lang="en">
<head>
    <title>Overview (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="./style.css">
    <link rel="start" href="./index.html">
</head>
    <body id="overview" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li class="active">Overview</li>
                    <li>Namespace</li>
                    <li>Class</li>
                    <li><a href="./tree.html">Tree</a></li>
                    <li><a href="./deprecated.html">Deprecated</a></li>
                    <li><a href="./todo.html">Todo</a></li>
                    <li><a href="./index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="./index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <h1>phpAPI: PHP Documentation Creator version 6.0</h1>
    <div class="comment"><h4>NAME / НАЗВАНИЕ</h4><br /></div>
            <div class="comment"><strong>See: <a href="#overview_description">readme.md</a></strong></div>
    <table class="title">
    <tr><th colspan="2" class="title">Namespaces</th></tr>
            <tr>
            <td class="name"><a href="formatters/package-summary.html">formatters</a></td>
            <td class="description">Formatts output for doclets</td>
        </tr>
            <tr>
            <td class="name"><a href="frames/package-summary.html">frames</a></td>
            <td class="description">Frames doclet</td>
        </tr>
            <tr>
            <td class="name"><a href="html/package-summary.html">html</a></td>
            <td class="description">HTML documentation generator.</td>
        </tr>
            <tr>
            <td class="name"><a href="markdown/package-summary.html">markdown</a></td>
            <td class="description">A text-to-HTML convertor</td>
        </tr>
            <tr>
            <td class="name"><a href="phpapi/package-summary.html">phpapi</a></td>
            <td class="description">Main program package</td>
        </tr>
            <tr>
            <td class="name"><a href="plain/package-summary.html">plain</a></td>
            <td class="description">Frames doclet</td>
        </tr>
            <tr>
            <td class="name"><a href="tags/package-summary.html">tags</a></td>
            <td class="description">Represents a documentation tag</td>
        </tr>
            <tr>
            <td class="name"><a href="template/package-summary.html">template</a></td>
            <td class="description">Completely separated from php code</td>
        </tr>
    </table>
    <div class="comment" id="overview_description"><h4>NAME / НАЗВАНИЕ</h4><br /><p>phpapi: The PHP Documentation Creator.<br />This is the fork of the Peej's Quick &amp; Dirty PHPDoc Clone.</p><br /><h4>VERSION / ВЕРСИЯ</h4><br /><p>5.0</p><br /><h4>DESCRIPTION / ОПИСАНИЕ</h4><br /><p>phpapi is a Javadoc style comment parser for PHP, written with an emphasis on speed and simplicity.<br />phpapi - это парсер комментариев в стиле Javadoc для PHP, написан с акцентом на скорость и простоту.</p><br /><h4>REQUIREMENTS / ТРЕБОВАНИЯ</h4><br /><p>PHP 5.4+ is required.</p><br /><h4>ABOUT / О ПРОГРАММЕ</h4><br /><p>phpapi uses the PHP tokenizer extension, parses the tokens and translates them into API documentation.<br />phpapi использует PHP-расширение tokenizer, анализирует токены PHP и транслирует их в документацию по API.</p><br /><h4>FEATURES / ВОЗМОЖНОСТИ</h4><ul><li>Fast speed.</li><li>Uses PHP tokenizer to take advantage of PHPs internal parsing functionality.</li><li>Parsing of any valid PHP file, with multiple classes and functions in the same file.</li><li>Simple to install and use, instant results.</li><li>Documents global constants.</li><li>Original template system for output.</li><li>Высокая скорость.</li><li>Использует PHP tokenizer для облегчения внутреннего разбора функциональности.</li><li>Парсит любой корректный PHP-файл, с несколькими классами и функциями в одном файле.</li><li>Простой в установке и использовании, мгновенный результат.</li><li>Документирует глобальные константы.</li><li>Оригинальная система шаблонов для вывода.</li></ul><h4>FILES / ФАЙЛЫ</h4><br /><pre><code>phpapi.php            - main executable<br />phpapi.ini            - Default config file<br />README.md             - This file<br />system/classes/       - Classes used by phpapi<br />system/frames/        - HTML doclet for output with frames<br />system/plain/         - HTML doclet for output without frames<br />system/markdown/      - Markdown parser<br />system/taglets/       - Doc Comment tags parsers<br />docs/                 - some docs and licenses<br />locales/              - Translation files<br />resources/            - Illustrations, javascript and so on<br />templates/frames/     - Templates for output with frames<br />templates/plain/      - Templates for output without frames<br />api/                  - Developer documentation<br /></code></pre><br /><h4>INSTALLATION / УСТАНОВКА</h4><br /><p>Unzip the archive somewhere, edit the config file and then run phpapi.php.<br />Распакуйте архив, отредактируйте конфигурационный файл и запустите phpapi.php.</p><br /><h4>USAGE / ИСПОЛЬЗОВАНИЕ</h4><br /><pre><code>./phpapi.php (if your config file is phpapi.ini)<br />./phpapi.php config.ini (if your config file is config.ini)<br />./phpapi.php config.ini &gt; result.txt (To save output mesages)<br /></code></pre><br /><p>To create a config file for your project, copy, rename the phpini.ini to project.ini file and edit it to your needs, it's fully commented.<br />Для созданияя конфигурационного файла вашего проекта, скопируйте, переименуйте phpapi.ini в project.ini и отредактируйте его в соответствие с имеющемися комментариями.</p><br /><h4>CONFIGURATION / КОНФИГУРАЦИЯ</h4><br /><p>phpapi supports a number of configuration directives:<br />phpapi поддерживает следующие директивы:</p><br /><pre><code>source           - The directory to look for files in,<br />destination      - The directory to place generated documentation in.<br />files            - Names or wildcards of files to parse.<br />ignore             Names of files or directories to ignore. Wildcards are NOT allowed.<br />subDirs = on|off - To look in each sub directory for files.<br />generator        - Documentation generator.<br />formatter        - Documentation formatter.<br />doclet           - The doclet to use for generating output.<br />verbose = on|off - Verbose mode outputs additional messages during execution.<br />defaultPackage   - It for elements without @package tag.<br />overview         - The name of file containing overview text to be placed on the overview page.<br />windowtitle      - The title to be placed in the HTML page.<br />doctitle         - The title to be placed near the top of the overview summary file.<br />header           - The header text to be placed at the top of each output file.<br /></code></pre><br /><h4>DOC COMMENTS</h4><br /><p>A full description of the format of doc comments can be found on the Sun Javadoc web site <a href="http://java.sun.com/j2se/javadoc/">javadoc</a> .<br />Doc comments for phpAPI are look like this:</p><br /><p>/** <br /><br />&#42; This is the typical format of a simple documentation comment<br /><br />&#42; in two lines.<br /><br />&#42; <br /><br />&#42; <strong>@param</strong> string $var Description<br /><br />&#42;/</p><br /><p>Class fields may be commented as:</p><br /><p>/** Comment.<br /><br />&#42; <strong>@var</strong> integer<br /><br />&#42;/</p><br /><p>or</p><br /><p>/** <strong>@var</strong> integer Comment */</p><br /><h4>TAGS / ТЭГИ</h4><br /><p>phpapi supports the following tags:<br />phpapi поддерживает следующие теги:</p><br /><pre><code>@abstract                    - defining a class or method as abstract<br />@access type                 - the access type of the field or method<br />@author name                 - author name, email, web...<br />@deprecated                  - deprecated element<br />@final                       - defining a class or method as final<br />{ @link package.class#member label }      - link to element<br />{ @linkplain package.class#member label } - plain link to element<br />@overview                    - detailed description of a package<br />@package name                - package name<br />@param type name description - description of method or function parameters<br />@private                     - element is private<br />@program                     - The title of the application, script or libruary<br />@protected                   - element is protected<br />@public                      - element is public<br />@return type description     - return value<br />@see package.class#member    - link to corresponding information<br />@since                       - since-text<br />@static                      - defining a class, method or member variable as static<br />@throws                      - exeptions<br />@var type name description   - variable description<br />@version                     - version number<br /></code></pre><br /><h4>COPYRIGHT AND LICENSE</h4><br /><p>This program is a fork of the PHPDoctor: The PHP Documentation Creator v2.0.5</p><br /><p>Copyright (C) 2005 Paul James <a href="&#109;&#x61;&#105;&#108;&#x74;&#111;&#x3a;&#x70;&#97;&#x75;l&#64;&#x70;&#101;&#101;&#x6a;&#46;&#x63;o&#46;&#x75;&#107;">&#x70;&#97;&#x75;l&#64;&#x70;&#101;&#101;&#x6a;&#46;&#x63;o&#46;&#x75;&#107;</a><br />Copyright (C) 2016 Victor Nabatov <a href="&#109;a&#105;l&#116;o&#x3a;g&#x72;&#101;&#x65;&#110;&#x72;&#97;&#x79;&#46;&#x73;&#112;&#x62;&#64;&#x67;&#109;&#x61;&#105;&#x6c;&#46;&#x63;&#111;&#x6d;">g&#x72;&#101;&#x65;&#110;&#x72;&#97;&#x79;&#46;&#x73;&#112;&#x62;&#64;&#x67;&#109;&#x61;&#105;&#x6c;&#46;&#x63;&#111;&#x6d;</a></p><br /><p>This program is free software.<br />You can redistribute it and/or modify it under the terms of the <a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode">Creative Commons Attribution-ShareAlike 4.0 International License</a> .<br />This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;<br />without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</p><br /><p>Эта программа является свободной.<br />Вы можете распространять и/или модифицировать ее в соответствии c условиями <a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode">Creative Commons Attribution-ShareAlike 4.0 International License</a> .<br />Эта программа распространяется в надежде что она будет полезной, но БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ;<br />даже без подразумеваемых гарантий КОММЕРЧЕСКОЙ ЦЕННОСТИ или ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ.</p></div>
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li class="active">Overview</li>
                    <li>Namespace</li>
                    <li>Class</li>
                    <li><a href="./tree.html">Tree</a></li>
                    <li><a href="./deprecated.html">Deprecated</a></li>
                    <li><a href="./todo.html">Todo</a></li>
                    <li><a href="./index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="./index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    </body>
</html>
